Skip to main content

Routers

Version type​

The Version (number or undefined): version number

Server type​

The Server (string or undefined): server address

UseProjectProxy type​

The UseProjectProxy (boolean or undefined) indicates whether a project proxy is used.

AccountShortName type​

The AccountShortName (string or undefined): short name for an account

ProjectShortName type​

The ProjectShortName (string or undefined): short name for a project

Authorization type​

The Authorization (string or undefined): authorization token

QueryObject type​

The QueryObject type is a record of key-value pairs where the keys are strings and the values are of unknown type.

SearchParams type​

The SearchParams type defines possible search parameters, which can be:

  • A string
  • A two-dimensional string array
  • A URLSearchParams object
  • A QueryObject

RoutingOptions interface​

The RoutingOptions interface defines options for routing requests.

Properties​

  • authorization? (Authorization): (Optional) Authorization token.
  • server? (Server): (Optional) Server address.
  • useProjectProxy? (UseProjectProxy): (Optional) Indicates if a project proxy should be used.
  • accountShortName? (AccountShortName): (Optional) Short name of the account.
  • projectShortName? (ProjectShortName): (Optional) Short name of the project.
  • query? (SearchParams): (Optional) Query parameters for the request.
  • headers? (Record<string, string>): (Optional) Headers to be included in the request.
  • body? (unknown): (Optional) The request body.
  • includeAuthorization? (boolean): (Optional) Determines whether authorization should be included.
  • inert? (boolean | ((fault: Fault) => boolean)): (Optional) When true, indicates an operation that is not state-changing.
  • paginated? (boolean): (Optional) Set to true when making a request to a paginated endpoint directly through the Router. Not needed for requests made through adapter methods.
  • parsePage? ((values: any[]) => any[]): (Optional) A function to parse paginated response values.
tip

Adapter methods handle paginated requests for you. It is recommended to use adapter methods rather than make requests through the Router class whenever possible.

warning

The parsePage property uses any for flexibility but may require careful handling to ensure type safety.